ISFTPConnection::DownloadFile Method

Downloads a file.

IDL

HRESULT DownloadFile(
    [in] BSTR remoteFile, 
    [in] VARIANT localFile, 
    [in] DataTransferType transferType, 
    [in] long startPositionLo, 
    [in] long startPositionHi
);

Parameters

remoteFile

The path to the remote file.

localFile

VT_BSTR or (VT_BSTR | VT_BYREF) or (VT_VARIANT | VT_BYREF)

The path to the local file.

VT_UNKNOWN or VT_DISPATCH

An object that supports the IStream interface.

startPositionLo

Offset (in bytes) from the beginning of the file where the read starts at. (Low order part)

startPositionHi

Offset (in bytes) from the beginning of the file where the read starts at. (High order part)

Remarks

For further information please see "8.2.1. Reading Files" of SSH File Transfer Protocol.